[Lim Yong En Dominic] iP #462

Arixeyeion · 2024-02-06T02:47:05Z

No description provided.

Let's tweak the docs/README.md (which is used as the user guide) to fit Duke better. Specifically, 1. mention product name in the title 2. mention adding a product screenshot and a product intro 3. tweak the flow to describe feature-by-feature

…ke to required IP level 0 text.

…bye" is given.

…ies based on level-4

…ing for tasks concerning time like deadline and event.

…Zoe will read saved tasks from previous sessions and she will save new tasks from the current session.

# Conflicts: # data/SavedTasks.txt # src/main/java/Deadline.java

…nerate zoe jar files.

# Conflicts: # src/main/java/zoe/Parser.java # src/main/java/zoe/Ui.java

KhoonSun47

Great work overall! Just a few minor refinements required to ensure alignment with Java Coding Standards and enhance overall code quality. Keep up the outstanding effort!

KhoonSun47 · 2024-02-06T23:36:04Z

src/main/java/zoe/Loader.java

@@ -0,0 +1,52 @@
+package zoe;
+
+import java.io.*;


Should you list your imported classes explicitly to follow the Java Coding Standard?

KhoonSun47 · 2024-02-06T23:46:46Z

src/main/java/zoe/Zoe.java

+package zoe;
+public class Zoe{
+    private Parser parser;
+    private TaskList tasks;


I like that you have distinguish clearly between single-valued and multi-valued variables, nice!

KhoonSun47 · 2024-02-06T23:54:23Z

src/main/java/zoe/Parser.java

+     * If invalid command like empty todo is given, calls the respective responses
+     * @param command
+     */
+    public String carryOutShortCommand(String command) {


It is good that your method name explains the entity to the reader accurately and at a sufficient level of detail, nice!

KhoonSun47 · 2024-02-06T23:58:27Z

src/main/java/zoe/Saver.java

+     * Saves data from the current zoe instance to a path when zoe closes
+     * @param path
+     */
+    public void saveTo(String path) {


It is good that your methods and classes follow the Java Code Quality of using nouns for classes/variables and verbs for methods/functions, nice!

KhoonSun47 · 2024-02-07T00:03:59Z

src/main/java/zoe/TaskList.java

+    }
+
+    /**
+     * Checks if a task exists in the list given an index when isValid(index) is called.


I noticed that there is no line spacing in between the description and parameter sections for your Javadocs comments, should you consider following the Java Coding Standard?

One of the comment does not have a method associated with it, should you consider removing it?

JerryWang0000

The progress is ahead of me so sorry I cannot comment on the graphic part, but I'm glad that the rest of the codes are "readable" and with clarity.

JerryWang0000 · 2024-02-08T15:13:08Z

src/main/java/zoe/Deadline.java

+
+    protected String date;
+    protected String formattedDate;
+    public Deadline(String desc) {


Will it be better if there is a blank line and no space at line 11?

JerryWang0000 · 2024-02-08T15:14:03Z

src/main/java/zoe/Deadline.java

+        LocalDate inputDate = LocalDate.parse(date);
+        this.formattedDate = inputDate.format(DateTimeFormatter.ofPattern("MMM d yyyy"));
+        this.type = "D";
+        this.isDone = false;


I like this naming

JerryWang0000 · 2024-02-08T15:14:53Z

src/main/java/zoe/Event.java

+ */
+public class Event extends Task {
+    protected String from;
+    protected String to;


Would it be better to state explicitly that the two strings represent timestamp?

JerryWang0000 · 2024-02-08T15:15:56Z

src/main/java/zoe/Event.java

+        this.from = str[1].split(" ",2)[1];
+        this.to = str[2].split(" ", 2)[1];
+        this.type = "E";
+        this.isDone = isDoneNumber.equals("1");


"this" might not be necessary here as there is no ambiguous reference.

JerryWang0000 · 2024-02-08T15:17:42Z

src/main/java/zoe/Loader.java

+            if (directory.exists() && file.exists()) {
+                BufferedReader reader = new BufferedReader(new FileReader(file));
+                ArrayList<Task> loadedTasks = new ArrayList<Task>();
+                String line;


The guideline would suggest not creating the object without initialization, but I'm not sure how to write better here tbh.

JerryWang0000 · 2024-02-08T15:21:32Z

src/main/java/zoe/Task.java

+ */
+public class Task {
+    protected String description;
+    protected String type;


Is it better to have these attributes final? As I think they can be confirmed upon initialization.

JerryWang0000 · 2024-02-08T15:22:56Z

src/main/java/zoe/Task.java

+    /**
+     * Records whether a task is done or not for data loading
+     */
+    public int isDoneNumerical() {


I thought the return type was boolean. Is it better to start the name with a verb?

JerryWang0000 · 2024-02-08T15:23:47Z

src/main/java/zoe/Task.java

+    /**
+     * Marks a task as done to reflect in zoe
+     */
+    public void markAsDone() {


I like this naming as it is clearer than my version.

JerryWang0000 · 2024-02-08T15:24:57Z

src/main/java/zoe/Ui.java

+    /**
+     * Prints opening statement
+     */
+    public String saysHi() {


Is it better to simply write sayHi()?

Assertions were implemented as a branch but not committed to before working on the CodingQuality branch. Let's commit this version with some CodingQuality implementation first as practice for pull requests. This way, I still get to see the effects of some merging conflicts and parallel pull requests.

There were some magic numbers in the code so this commits rectify that problem. Doing away with magic numbers makes it easier to debug in future and provides clarity in code.

Add rest of the CodeQuality changes.

Late commit for assertions.

AjayArvind2207

This is very well written code! Aside from some nits in the naming convention, the code LGTM. Keep it up and I hope to see this project develop further!

AjayArvind2207 · 2024-02-13T13:57:18Z

src/main/java/zoe/TaskList.java

+        this.tasks.add(t);
+    }
+    /**
+     * Deletes a new task to the list, when delete(task) is called
+     * @param i
+     */
+    public void delete(int i) {
+        tasks.remove(Integer.valueOf(i) - 1);


I feel there is an inconsistent usage of 'this'. Some methods use this referencing while others do not

AjayArvind2207 · 2024-02-13T13:59:09Z

src/main/java/zoe/Task.java

+    }
+
+    public String getStatusIcon() {
+        return (isDone ? "X" : " ");


Maybe you can consider using this.isDone as opposed to isDone to be more consistent with styling

Suggested change

return (isDone ? "X" : " ");

return (this.isDone ? "X" : " ");

AjayArvind2207 · 2024-02-13T14:00:24Z

src/main/java/zoe/Parser.java

+        } else {
+            if (command.equals("todo")) {
+                res += ui.todoDescription();
+            } else {
+                res += ui.invalidCommand();


I really like your method names and they are very descriptive!

…owing order: Todos, Events, Deadlines where Deadlines are sorted based on date.

…er input for better clarity. Also changed maximum size of chatbot text to allow for dynamic sizing based on output text.

# Conflicts: # data/SavedTasks.txt

…ata is processed for more flexible reading from file and neater presentation of data. Add more JUnit test to todo and event.

…. Change saving using bye to saving whenever a user input is parsed to avoid dataloss should the user choose to close the application using the "X" button.

…nd " with the empty space.

Change Ui picture so that it reflects new functionality as stated above

…ely advise the user on how to use it

…ource Update README to let user know that keyword in find <keyword> is case sensitive

damithc and others added 30 commits January 7, 2024 18:33

docs/README.md: Tweak document template

55f9f9f

Let's tweak the docs/README.md (which is used as the user guide) to fit Duke better. Specifically, 1. mention product name in the title 2. mention adding a product screenshot and a product intro 3. tweak the flow to describe feature-by-feature

Add Gradle support

f837ddb

Bump gradle and lib version

a6f7324

Changed name from duke to zoe and changed function from displaying du…

1dcc2cd

…ke to required IP level 0 text.

Added the echo capability, bot will only terminate when the command "…

26e1387

…bye" is given.

Add and List directly implemented into main.

9211cdf

added mark/unmark capability

88d12d6

reverted "Zoe" to main, created Zoe outside of main and all dependenc…

ca10286

…ies based on level-4

added some error handling for zoe. Still missing specific error handl…

1dc9929

…ing for tasks concerning time like deadline and event.

added the delete capability

8b9fc91

Add automated testing from week2

36193f2

Add saving capability through loader and saver classes. Upon launch, …

36eda6d

…Zoe will read saved tasks from previous sessions and she will save new tasks from the current session.

Fix loading issue

fa215d6

Add simple date capability

6742598

Add more oop. Change main to zoe.

f4fbb46

Remove main

97f75c5

Merge branch 'branch-Level-8'

d076702

# Conflicts: # data/SavedTasks.txt # src/main/java/Deadline.java

Fix Ui printing out wrong information regarding index size

50df0be

Shift interacting classes to package except Zoe as in the main file.

927304d

Merge remote-tracking branch 'origin/add-gradle-support'

e15df74

Shift Saver to package, make constructor public.

6f4bdb8

Add test files to test event and todo saves

97daa27

Delete duke from folder to avoid confusion. Adjust build.gradle to ge…

9da7b15

…nerate zoe jar files.

Attempt to add javadoc

7433b9b

Add javadocs to public classes and methods

e01379b

Add find capability

74ae6ad

Adjust code to abide by coding standard

c06ee4b

Merge branch 'branch-A-Javadoc', resolve conflicts

de690b3

# Conflicts: # src/main/java/zoe/Parser.java # src/main/java/zoe/Ui.java

Merge branch 'branch-level-9'

9956dd2

Attempt checkstyle

8c6f81e

Change to GUI

6e2466f

KhoonSun47 reviewed Feb 7, 2024

View reviewed changes

JerryWang0000 reviewed Feb 8, 2024

View reviewed changes

Arixeyeion and others added 6 commits February 13, 2024 13:37

Change path to launcher to create new jar file

e6fe7f2

Add rest of the CodeQuality changes.

c80a8aa

There were some magic numbers in the code so this commits rectify that problem. Doing away with magic numbers makes it easier to debug in future and provides clarity in code.

Merge pull request #2 from Arixeyeion/branch-A-CodeQuality

b8be124

Add rest of the CodeQuality changes.

Merge branch 'master' into branch-A-Assertions

db78956

Merge pull request #1 from Arixeyeion/branch-A-Assertions

613051d

Late commit for assertions.

AjayArvind2207 reviewed Feb 13, 2024

View reviewed changes

Arixeyeion added 17 commits February 14, 2024 13:01

Add sorting functionality for tasks. Tasks are now sorted in the foll…

254dfa1

…owing order: Todos, Events, Deadlines where Deadlines are sorted based on date.

Change background colour to differentiate between chatbot text and us…

f90d9a8

…er input for better clarity. Also changed maximum size of chatbot text to allow for dynamic sizing based on output text.

Merge branch 'branch-C-Sort'

f4802fb

# Conflicts: # data/SavedTasks.txt

Add and modify more javadocs to public methods and objects

b257544

Test more potential exceptions that users may face. Standardize how d…

8f36312

…ata is processed for more flexible reading from file and neater presentation of data. Add more JUnit test to todo and event.

Add pause when user inputs "bye" so the chat bot can say bye properly…

f86607a

…. Change saving using bye to saving whenever a user input is parsed to avoid dataloss should the user choose to close the application using the "X" button.

Update warning message to include find for case when user keys in "fi…

a411550

…nd " with the empty space.

Add picture to docs for website creation

0fe8eac

Change deadline to read dates and times instead of just dates

783d486

Change Ui picture so that it reflects new functionality as stated above

Trial docs for webpage

8fa4752

Check picture on website

d8c328e

Check image on website

aaf46f2

Trial website image upload again

796585d

Fix deadline date time error display message to match updated version

3031066

Adjust Zoe to catch more potential user errors so that it can accurat…

8e635e3

…ely advise the user on how to use it

Update javadocs to reflect code that is made in reference to online s…

589f25c

…ource Update README to let user know that keyword in find <keyword> is case sensitive

Update zoe download location to the released version of the ip

40c1530

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Lim Yong En Dominic] iP #462

[Lim Yong En Dominic] iP #462

Arixeyeion commented Feb 6, 2024

KhoonSun47 left a comment

KhoonSun47 Feb 6, 2024

KhoonSun47 Feb 6, 2024

KhoonSun47 Feb 6, 2024

KhoonSun47 Feb 6, 2024

KhoonSun47 Feb 7, 2024

JerryWang0000 left a comment

JerryWang0000 Feb 8, 2024

JerryWang0000 Feb 8, 2024

JerryWang0000 Feb 8, 2024

JerryWang0000 Feb 8, 2024

JerryWang0000 Feb 8, 2024

JerryWang0000 Feb 8, 2024

JerryWang0000 Feb 8, 2024

JerryWang0000 Feb 8, 2024

JerryWang0000 Feb 8, 2024

AjayArvind2207 left a comment

AjayArvind2207 Feb 13, 2024

AjayArvind2207 Feb 13, 2024

AjayArvind2207 Feb 13, 2024

	return (isDone ? "X" : " ");
	return (this.isDone ? "X" : " ");

[Lim Yong En Dominic] iP #462

Are you sure you want to change the base?

[Lim Yong En Dominic] iP #462

Conversation

Arixeyeion commented Feb 6, 2024

KhoonSun47 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JerryWang0000 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AjayArvind2207 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment